docs(vrl): Automatically generate VRL function documentation#24719

Merged

thomasqueirozb merged 123 commits intomasterfrom

automatic-vrl-documentation-website

Mar 7, 2026

Contributor

thomasqueirozb commented Feb 23, 2026 •

edited

Loading

Summary

Last part of the automatic doc generation RFC vectordotdev/vrl#280

A lot of my verification for the changes done in this were via a very handy website diff viewer (https://pianomister.github.io/). I suggest setting the display to iPad and zooming out to 90%. Use this link to get see the differences between the current website and the deployed branch.

Many many issues were fixed. The following are (very likely incomplete) lists of the most notable fixes and changes:

"breaking" difference

exists argument is no longer type path and is now type any. There is no way to indicate path arguments in the type system currently.

Parameter type fixes

fn	parameter	old	fixed
validate_json_schema	value	any	string
validate_json_schema	schema_definition	any	string
chunks	param	<array \| string>	string
parse_timestamp	value	string	<timestamp \| string>
uuid_from_friendly_id	value	timestamp	string
parse_regex	numeric_groups	regex	boolean
parse_regex_all	numeric_groups	regex	boolean
ip_ntoa	param	string	integer
truncate	limit	<integer \| float>	integer

Parameters with incorrect names

fn	old	fixed
ip_cidr_contains	ip	value
ip_to_ipv6	ip	value
ipv6_to_ipv4	ip	value
ip_subnet	ip	value
sieve	pattern	permitted_characters
exists	path	field

Other fixes

decode_lz4: buf_size's default value
aggregate_vector_metric -> aggregate_vector_metrics (title)
format_number: grouping_separator incorrect default
strip_ansi_codes: removed invalid example
truncate: ellipsis parameter removed
parse_xml: trim parameter was missing
Added many parameter defaults. (e.g. decode_lz4, encode_lz4, encode_json, encode_key_value, encode_logfmt)

Vector configuration

NA

How did you test this PR?

make generate-docs && cd website && make serve

Change Type

Bug fix
New feature
Non-functional (chore, refactoring, docs)
Performance

Is this a breaking change?

Yes
No

Does this PR include user facing changes?

Yes. Please add a changelog fragment based on our guidelines.
No. A maintainer will apply the no-changelog label to this PR.

References

Closes: Auto-generate VRL function documentation vrl#280

thomasqueirozb added 29 commits

February 6, 2026 14:26


          Add generation of cue files from vrl Function

7c4be90


          Use __mock_return_values_for_tests to show mocked examples

d028ae8


          Handle kind::any

73d9585


          Replace generate-component-docs with generate-docs

ea36b23


          Bump VRL

58fa9ab


          chore(vrl): Bump vrl and add return_kind to functions

4f02f21


          Merge branch 'function-return' into automatic-vrl-documentation

d5c6ce5


          Enable all features for vector-vrl-functions

4cc7bb4


          Add stubs and implement new params

a571dac


          Bump vrl and unstub pure

ad740b0


          Bump vrl and unstub notices

f6431ae


          Trim strings

8c42a0a


          Merge remote-tracking branch 'origin/master' into automatic-vrl-docum…

f0c2b92

…entation


          chore(vrl): Bump VRL and implement category for functions

b5553de


          Merge branch 'function-category' into automatic-vrl-documentation

55e557b


          Use .category()

e4d921a


          Merge remote-tracking branch 'origin/master' into automatic-vrl-docum…

74e4020

…entation


          chore(vrl): bump VRL and use Parameter builder

cc66ebe


          Add .enum_variants to aggregate_vector_metrics

4b8797e


          Add missing import

f2a3ddf


          Merge branch 'parameter-enum-variant' into automatic-vrl-documentation

06eb975


          Add support for enum_variants

44cacba


          Merge remote-tracking branch 'origin/master' into automatic-vrl-docum…

443e765

…entation


          Add Raises block to remap rendering

2504f35


          Merge remote-tracking branch 'origin/master' into automatic-vrl-docum…

c157925

…entation


          Bump vrl

decc387


          Fix clippy

142b3d3


          Install protoc when compiling vdev

c4b4600


          Add generated files

5f0ef54

This comment was marked as off-topic.

Sign in to view

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview


          ci-test: make docs incorrect

2320bb5

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

github-actions bot and others added 2 commits

March 6, 2026 15:45


          Update generated VRL docs

ce1ea59


          Update vdev cache keys

ef6308a

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

github-actions bot and others added 2 commits

March 6, 2026 16:15


          Update generated VRL docs

c313398


          Revert mock changes

50c436c

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

github-actions bot and others added 2 commits

March 6, 2026 16:19


          Update generated VRL docs

2feff79


          GHA trigger

28b46ff

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

pront reviewed

View reviewed changes

.github/actions/install-vdev/action.yml Outdated Show resolved Hide resolved


          Update warning comment

031e565

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

thomasqueirozb enabled auto-merge

March 6, 2026 16:49

thomasqueirozb added this pull request to the merge queue

github-merge-queue bot removed this pull request from the merge queue due to failed status checks

thomasqueirozb added this pull request to the merge queue

github-merge-queue bot removed this pull request from the merge queue due to failed status checks


          Merge branch 'master' into automatic-vrl-documentation-website

8910b3d

Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

thomasqueirozb enabled auto-merge

March 6, 2026 23:23


          Merge branch 'master' into automatic-vrl-documentation-website

9565d14

Contributor

github-actions bot commented Mar 7, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

thomasqueirozb added this pull request to the merge queue

Merged via the queue into master with commit b519edd

69 of 71 checks passed

thomasqueirozb deleted the automatic-vrl-documentation-website branch

March 7, 2026 19:33

github-actions bot locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain: ci domain: external docs domain: vdev no-changelog